<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>RaftLib: PortBase Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">RaftLib
   &#160;<span id="projectnumber">0.3a</span>
   </div>
   <div id="projectbrief">C++ Stream Processing Template Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_port_base-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PortBase Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="portbase_8hpp_source.html">portbase.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PortBase:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="class_port_base__inherit__graph.svg" width="86" height="118"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad034502b053f3cd7939d651b2d72cd0a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_f_i_f_o.html">FIFO</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_port_base.html#ad034502b053f3cd7939d651b2d72cd0a">operator[]</a> (const std::string &amp;&amp;port_name)=0</td></tr>
<tr class="separator:ad034502b053f3cd7939d651b2d72cd0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29870b5e201f46a806d2269d7f4635dc"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_port_base.html#a29870b5e201f46a806d2269d7f4635dc">hasPorts</a> ()=0</td></tr>
<tr class="separator:a29870b5e201f46a806d2269d7f4635dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc54c92e3b9d1967e8a8c7e74d7507d3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_port_iterator.html">PortIterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_port_base.html#afc54c92e3b9d1967e8a8c7e74d7507d3">begin</a> ()=0</td></tr>
<tr class="separator:afc54c92e3b9d1967e8a8c7e74d7507d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50427e7a1beea0d5111ccc81ee418178"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_port_iterator.html">PortIterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_port_base.html#a50427e7a1beea0d5111ccc81ee418178">end</a> ()=0</td></tr>
<tr class="separator:a50427e7a1beea0d5111ccc81ee418178"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="portbase_8hpp_source.html">portbase.hpp</a> - Interface for port types. Ensures that all port sub-classes have at least the functions listed below.</p>
<dl class="section author"><dt>Author</dt><dd>: Jonathan Beard </dd></dl>
<dl class="section version"><dt>Version</dt><dd>: Sun Nov 30 10:22:46 2014</dd></dl>
<p>Copyright 2014 Jonathan Beard</p>
<p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:</p>
<p><a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p>
<p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="afc54c92e3b9d1967e8a8c7e74d7507d3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="class_port_iterator.html">PortIterator</a> PortBase::begin </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>begin - returns a forward iterator to the port list, implementations should be thread safe so that auto- parallelized code can function properly. </p><dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_port_iterator.html">PortIterator</a> - points to first port, not in alphabetical or necessarily any order. </dd></dl>

<p>Implemented in <a class="el" href="class_port.html#abf4d86026b67f6c02db3e3abb0f2e8b4">Port</a>.</p>

</div>
</div>
<a class="anchor" id="a50427e7a1beea0d5111ccc81ee418178"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="class_port_iterator.html">PortIterator</a> PortBase::end </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>end - returns one past the end of the iterator, should be suitable for usage in a for( xxx : xxx ) loop just as in any other meaningful usage of a forward iterator. </p><dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_port_iterator.html">PortIterator</a> - points to one past the last port. </dd></dl>

<p>Implemented in <a class="el" href="class_port.html#aa85be3fb7734863d482bf002e0f0923d">Port</a>.</p>

</div>
</div>
<a class="anchor" id="a29870b5e201f46a806d2269d7f4635dc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool PortBase::hasPorts </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>hasPorts - should return false if this port object is empty. </p><dl class="section return"><dt>Returns</dt><dd>bool - true if no ports </dd></dl>

<p>Implemented in <a class="el" href="class_port.html#a7042f5b5c2ab14c9591a4984811a6012">Port</a>.</p>

</div>
</div>
<a class="anchor" id="ad034502b053f3cd7939d651b2d72cd0a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="class_f_i_f_o.html">FIFO</a>&amp; PortBase::operator[] </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&amp;&#160;</td>
          <td class="paramname"><em>port_name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>operator[] - enables lookup of ports by name, which in turn enables the user to name each port something that is telling of the underlying function. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">port_name</td><td>- name of the port you wish to get </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_f_i_f_o.html">FIFO</a>&amp; </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">-</td><td>should throw a <a class="el" href="class_port_not_found_exception.html">PortNotFoundException</a> if port_name doesn't exist. </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="class_port.html#a08cf165426982d83e5a191ba74cc6e5d">Port</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="portbase_8hpp_source.html">portbase.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 12 2015 12:16:50 for RaftLib by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
